.. Hydra Paste documentation master file, created by
   sphinx-quickstart on Tue Mar 10 22:43:39 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Hydra Paste Documentation
#########################

:ref:`search`

.. toctree::
   :caption: Table Of Contents:
   :name: mastertoc
   :maxdepth: 3

   api
   install
   opsec
   legal

------------


About
=====
Hydra Paste is a website for sharing shit. You can upload files and text for your
friends, coworkers, and random strangers on the internet to see. Just don't show
that shady guy who lives down the street. He'll probably attack the site with bots.

Philosophy
==========
Our philosophy is pretty damn simple: *Make sharing files easy*. This doesn't have too
much philosophical depth, so instead, here's a quote from someone who was a stoic
philosophe:

    "I came, I saw, I uploaded some dank memes"

    -- Julius Caesar |CITE|_

.. |CITE| replace:: :sup:`[Citation Needed]`
.. _CITE: https://en.wikipedia.org/wiki/Wikipedia:Citation_needed

Using Hydra Paste
=================
There are two ways to use Hydra Paste: the plebian way (web interface), and the 1337 way with the API.
Both methods are described below.

Web Interface
-------------
There is currently both a `web upload`_ and web paste viewer.

.. _web upload: https://paste.hydra.ws/upload

Client Applications
-------------------
Currently, the flagship prototype of an application taking advantage of the Hydra Paste
API is the `CLI Client`_. It is written in Python 3, and shows how easy it is to work
with the API. Moreover, it is easily importable to external projects. This is the most
1337 way to use Hydra Paste.

.. _CLI Client: https://paste.hydra.ws/p/F0uy

There is also `a Shutter Plugin`_ which allows direct upload of screenshots from
shutter. It is written in Ruby.

.. _a Shutter Plugin: https://paste.hydra.ws/p/C-

An `OpenPuush Fork`_ is planned in the future, for our friends running Windows.

.. _OpenPuush Fork: https://github.com/hmbl9r/OpenPuush

Installation
============
Installation for development or full-scale deployment is pretty simple. Please see
:doc:`install` for further information

Developers
==========
We're more enthusiastic than `Steve Balmer`_ about our developers.  Because of
our philosophy, we make it as easy as possible for third party applications to use
Hydra Paste's data.  We make it easy for you too access, modify, and control your
data.  See our :doc:`api`.

.. _Steve Balmer: https://www.youtube.com/watch?v=KMU0tzLwhbE

Notes fom the Admin
===================
The adminstrator of this website is a `pretty serious`_. You should read what he's
got to say over in :doc:`opsec`.

.. _pretty serious: http://youtu.be/2NS7Gkv4NNA
